Sedaro Satellite API (3.2.0)

Download OpenAPI specification:Download

Allows for consumption of Sedaro Satellite services. Read more about Sedaro Satellite at satellite.sedaro.com.

Branches

Templates

There is a lot to cover here but for now we will cover the basics.

Branches most fundamentally define Templates - either an Agent Template or a Scenario Template. These Templates then define reusable, instantiatable definitions for an Agent or Scenario. To recap, an Agent is an actor within a simulation and a Scenario defines the simulation (including the Agents that make it up and the Templates that define them). Therefore, Agent Templates capture the model for a system while Scenario Templates capture the instantiation of differentiated Agents, the resolution of their abstract "Targets", and the configuration of the simulation clock.

A Template is made up of Blocks - each existing within a Block Group inside of the Template. A Block Group is much like a traditional database table but with more flexibility. The following is the default Scenario Template:

{
    'ClockConfig': {}, # Block Group
    'TemplateRef': {}, # Block Group
    'Agent': {}, # Block Group
    'clockConfig': None, # root property (in this case a relation to a ClockConfig Block)
    'agents': [], # root property (in this case a relation to a set of Agent Blocks)
}

Templates are modified by creating, updating, and deleted their Blocks using the "Blocks" endpoints below.

Template Composition

Scenario Template
Agent Template

All Blocks not referenced above under "Scenario Template"

Get a branch

Retrieves the branch with the provided id.

path Parameters
branchId
required
integer (Branchid)

Responses

Response samples

Content type
application/json
Example
{
  • "name": "string",
  • "description": "string",
  • "id": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateModified": "2019-08-24T14:15:22Z",
  • "simulationRequired": true,
  • "repository": 0,
  • "user": 0,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "shareable": true,
  • "sharePwRqd": true,
  • "numSimulations": 0,
  • "dataSchema": { },
  • "data": {
    }
}

Branch off existing branch

Creates a new branch based on and in the same repository as the branch associated with the provided id.

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
name
required
string (Name) <= 32 characters
description
string (Description) <= 300 characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
Example
{
  • "name": "string",
  • "description": "string",
  • "id": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateModified": "2019-08-24T14:15:22Z",
  • "simulationRequired": true,
  • "repository": 0,
  • "user": 0,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "shareable": true,
  • "sharePwRqd": true,
  • "numSimulations": 0,
  • "dataSchema": { },
  • "data": {
    }
}

Delete a branch

Deletes the branch with the provided id.

path Parameters
branchId
required
integer (Branchid)

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "deletedEntities": [
    ]
}

Update a branch

Updates updateable fields on the branch with the provided id. Note:

  • shareable indicates whether shareable links are valid for this branch.
  • password indicates whether the shareable link requires a password.
path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
name
string (Name) <= 32 characters
description
string (Description) <= 300 characters
shareable
boolean (Shareable)
password
string (Password) [ 8 .. 128 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "shareable": true,
  • "password": "stringst"
}

Response samples

Content type
application/json
Example
{
  • "name": "string",
  • "description": "string",
  • "id": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateModified": "2019-08-24T14:15:22Z",
  • "simulationRequired": true,
  • "repository": 0,
  • "user": 0,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "shareable": true,
  • "sharePwRqd": true,
  • "numSimulations": 0,
  • "dataSchema": { },
  • "data": {
    }
}

Verify branch bassword

Route to verify password when a user tries to access a branch with the provided id via a password protected shareable link. If successful, returns a success message with a set-cookie. The cookie stores a jwt that allows for non-owner collaborators to send GET requests to the corresponding branch.

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
password
required
string (Password)

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Commit changes to a branch

Takes all changes to the blocks on the branch with the provided id and commits them to the corresponding version-controlled branch.

path Parameters
branchId
required
integer (Branchid)
query Parameters
commitMessage
required
string (Commitmessage)

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Merge branch into another branch

Merges branch with incomingBranchId into branch with currentBranchId. This route has two functions:

  • To initiate the merge, send the request with no body. If there are no conflicts, it will successfully complete the merge and send back the resulting branch.
  • If there are conflicts, the response body will have a key of conflicts with a list of conflict objects outlining the "current" and "incoming" changes. Review the list, and send a second request to the same route including a list of resulutions (see optional resultions param in the request body schema below) indicating where you would like to keep the "current" or "incoming" changes. The indices in the resultions list should correspond with the indices of the conflicts list.
path Parameters
currentBranchId
required
integer (Currentbranchid)
incomingBranchId
required
integer (Incomingbranchid)
Request Body schema: application/json
resolutions
Array of strings (Resolutions)
Items Enum: "current" "incoming"

Responses

Request samples

Content type
application/json
{
  • "resolutions": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "name": "string",
  • "description": "string",
  • "id": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateModified": "2019-08-24T14:15:22Z",
  • "simulationRequired": true,
  • "repository": 0,
  • "user": 0,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "shareable": true,
  • "sharePwRqd": true,
  • "numSimulations": 0,
  • "dataSchema": { },
  • "data": {
    }
}

Get saved branch data

Retrieves all committed branch data (object with all the blocks) from the branch with the given id.

path Parameters
branchId
required
integer (Branchid)

Responses

Response samples

Content type
application/json
Example
{
  • "latestId": "string",
  • "Algorithm": { },
  • "Battery": { },
  • "BatteryCell": { },
  • "BodyFrameVector": { },
  • "BusRegulator": { },
  • "Component": { },
  • "ConOps": { },
  • "Condition": { },
  • "FieldOfView": { },
  • "FOVConstraint": { },
  • "Load": { },
  • "LoadState": { },
  • "OperationalMode": { },
  • "Orbit": { },
  • "PointingMode": { },
  • "ReferenceVector": { },
  • "Satellite": { },
  • "SolarArray": { },
  • "SolarCell": { },
  • "Subsystem": { },
  • "Surface": { },
  • "SurfaceMaterial": { },
  • "TargetGroup": { },
  • "Target": { },
  • "TempControllerState": { },
  • "ThermalInterface": { },
  • "ThermalInterfaceMaterial": { },
  • "conOps": "string",
  • "missionOrbit": "string",
  • "satellite": "string",
  • "position": null,
  • "velocity": null,
  • "torque": null,
  • "positionSolution": null,
  • "positionCovariance": null,
  • "velocitySolution": null,
  • "velocityCovariance": null
}

Get committed branch data

Retrieves all saved branch data (object with all the blocks) from the branch with the given id.

path Parameters
branchId
required
integer (Branchid)

Responses

Response samples

Content type
application/json
Example
{
  • "latestId": "string",
  • "Algorithm": { },
  • "Battery": { },
  • "BatteryCell": { },
  • "BodyFrameVector": { },
  • "BusRegulator": { },
  • "Component": { },
  • "ConOps": { },
  • "Condition": { },
  • "FieldOfView": { },
  • "FOVConstraint": { },
  • "Load": { },
  • "LoadState": { },
  • "OperationalMode": { },
  • "Orbit": { },
  • "PointingMode": { },
  • "ReferenceVector": { },
  • "Satellite": { },
  • "SolarArray": { },
  • "SolarCell": { },
  • "Subsystem": { },
  • "Surface": { },
  • "SurfaceMaterial": { },
  • "TargetGroup": { },
  • "Target": { },
  • "TempControllerState": { },
  • "ThermalInterface": { },
  • "ThermalInterfaceMaterial": { },
  • "conOps": "string",
  • "missionOrbit": "string",
  • "satellite": "string",
  • "position": null,
  • "velocity": null,
  • "torque": null,
  • "positionSolution": null,
  • "positionCovariance": null,
  • "velocitySolution": null,
  • "velocityCovariance": null
}

Jobs

Start a simulation

branchId is the ID of the Scenario Template Branch to simulate.

path Parameters
branchId
required
integer (Branchid)

Responses

Response samples

Content type
application/json
{
  • "jobType": "SIMULATION",
  • "status": "PENDING",
  • "branch": "string",
  • "bedRef": "string",
  • "dataRef": "string"
}

Get simulation status

path Parameters
branchId
required
integer (Branchid)
jobId
required
integer (Jobid)
query Parameters
latest
boolean (Latest)
Default: false

Responses

Response samples

Content type
application/json
{
  • "jobType": "SIMULATION",
  • "status": "PENDING",
  • "branch": "string",
  • "bedRef": "string",
  • "dataRef": "string",
  • "startTime": 0,
  • "currentTime": 0,
  • "stopTime": 0
}

Terminate a running simulation

path Parameters
branchId
required
integer (Branchid)
jobId
required
integer (Jobid)

Responses

Response samples

Content type
application/json
{
  • "jobType": "SIMULATION",
  • "status": "PENDING",
  • "branch": "string",
  • "bedRef": "string",
  • "dataRef": "string"
}

[NOT FUNCTIONAL] Pause/resume running simulation

path Parameters
branchId
required
integer (Branchid)
jobId
required
integer (Jobid)
query Parameters
action
required
string (Action)
Enum: "PAUSE" "RESUME"

Responses

Response samples

Content type
application/json
{
  • "jobType": "SIMULATION",
  • "status": "PENDING",
  • "branch": "string",
  • "bedRef": "string",
  • "dataRef": "string"
}

Data

Queries

Data is queried via 4 URL query parameters:

  • id: The ID of the data set to query. This ID can be retrieved from the Simulation Job.
  • start: The start time of the window in MJD
  • stop: The stop time of the window in MJD
  • binWidth: (optional) The bin width to use to down-sample the data. If omitted, data will be full resolution.

Example request: GET: /data/?id=<id>&start=<start>&stop=<stop>&binWidth=<binWidth>

Response

Data is returned from a query in the following format:

{
    "meta": {}, // TODO
    "series": { 
        <streamId>: [
            [<timestamp1::MJD>, <timestamp2::MJD>, ...],
            {
                <agentId>: {
                    <blockId>: {
                        <stateVariableA>: [<valueA1>, <valueA2>, ...],
                        <stateVariableB>: [<valuB1>, <valueB2>, ...],
                        ...
                    },
                    <stateVariableC>: [<valueC1>, <valueC2>, ...]
                },
                ...
            }
        ],
        ...
    }
}

Query Data

Queries Data Service for data under the provided id.

query Parameters
id
required
integer (Id)
start
required
number (Start)
stop
required
number (Stop)
binWidth
number (Binwidth)

Responses

Response samples

Content type
application/json
null

Operational Mode

Create Operational Mode

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
priority
required
integer (Priority) >= 0

Higher values have higher priority. Default op modes have priorty == 0.

minOccurrenceDuration
number (Min Occurrence Duration [min]) >= 0
maxOccurrenceDuration
number (Max Occurrence Duration [min]) >= 0
minTimeBetweenOccurrences
number (Min Time Between Occurrences [min]) >= 0
pointingMode
required
string (ID of Associated PointingMode Block)

Relationship to a PointingMode block. Reverse key: PointingMode.operationalModes. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

conditions
Array of any (IDs of Associated Condition Blocks)
Default: []

Relationship to one or more Condition blocks. Reverse key: Condition.operationalModes. On delete: SET_NONE (remove ID of referenced block from this relationship field).

conOps
required
string (ID of Associated ConOps Block)

Relationship to a ConOps block. Reverse key: ConOps.operationalModes. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "priority": 0,
  • "minOccurrenceDuration": 0,
  • "maxOccurrenceDuration": 0,
  • "minTimeBetweenOccurrences": 0,
  • "pointingMode": "string",
  • "conditions": [ ],
  • "conOps": "string"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Operational Mode

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Operational Mode

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
priority
required
integer (Priority) >= 0

Higher values have higher priority. Default op modes have priorty == 0.

minOccurrenceDuration
number (Min Occurrence Duration [min]) >= 0
maxOccurrenceDuration
number (Max Occurrence Duration [min]) >= 0
minTimeBetweenOccurrences
number (Min Time Between Occurrences [min]) >= 0
pointingMode
required
string (ID of Associated PointingMode Block)

Relationship to a PointingMode block. Reverse key: PointingMode.operationalModes. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

conditions
Array of any (IDs of Associated Condition Blocks)
Default: []

Relationship to one or more Condition blocks. Reverse key: Condition.operationalModes. On delete: SET_NONE (remove ID of referenced block from this relationship field).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "priority": 0,
  • "minOccurrenceDuration": 0,
  • "maxOccurrenceDuration": 0,
  • "minTimeBetweenOccurrences": 0,
  • "pointingMode": "string",
  • "conditions": [ ]
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Attitude Control Algorithm

Create Sliding Mode 3x3 Algorithm

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
rate
required
number (Update Rate [Hz])
algorithmType
required
string (Algorithmtype)
Value: "ATTITUDE_CONTROL"
algorithmSubtype
required
string (Algorithmsubtype)
Value: "SLIDING_MODE"
actuators
Array of any (IDs of Associated Actuator Blocks)
Default: []

Relationship to one or more Actuator blocks. On delete: SET_NONE (remove ID of referenced block from this relationship field).

gainK
required
number (Gain K) > 0

Alters the relative weighting between angular rate error.

gainG
required
number (Gain G) > 0

Scales the overall speed of convergence.

gainC
required
number (Gain C) > 0

Dictates the strength of the magnetorquer desaturation torques.

epsilon
required
number (Epsilon) > 0

The sliding mode boundary layer. Higher values may produce more error, but less chattering.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "rate": 0,
  • "algorithmType": "ATTITUDE_CONTROL",
  • "algorithmSubtype": "SLIDING_MODE",
  • "actuators": [ ],
  • "gainK": 0,
  • "gainG": 0,
  • "gainC": 0,
  • "epsilon": 0
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Sliding Mode 3x3 Algorithm

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Sliding Mode 3x3 Algorithm

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
rate
required
number (Update Rate [Hz])
algorithmType
required
string (Algorithmtype)
Value: "ATTITUDE_CONTROL"
algorithmSubtype
required
string (Algorithmsubtype)
Value: "SLIDING_MODE"
actuators
Array of any (IDs of Associated Actuator Blocks)
Default: []

Relationship to one or more Actuator blocks. On delete: SET_NONE (remove ID of referenced block from this relationship field).

gainK
required
number (Gain K) > 0

Alters the relative weighting between angular rate error.

gainG
required
number (Gain G) > 0

Scales the overall speed of convergence.

gainC
required
number (Gain C) > 0

Dictates the strength of the magnetorquer desaturation torques.

epsilon
required
number (Epsilon) > 0

The sliding mode boundary layer. Higher values may produce more error, but less chattering.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "rate": 0,
  • "algorithmType": "ATTITUDE_CONTROL",
  • "algorithmSubtype": "SLIDING_MODE",
  • "actuators": [ ],
  • "gainK": 0,
  • "gainG": 0,
  • "gainC": 0,
  • "epsilon": 0
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Temperature Controller State

Create Temperature Controller State

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
constantTemperature
required
number (Constanttemperature)
tempController
required
string (ID of Associated TempController Block)

Relationship to a TempController block. Reverse key: TempController.tempControllerStates. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

operationalModes
Array of any (IDs of Associated OperationalMode Blocks)
Default: []

Relationship to one or more OperationalMode blocks. Reverse key: OperationalMode.tempControllerStates. On delete: SET_NONE (remove ID of referenced block from this relationship field).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "constantTemperature": 0,
  • "tempController": "string",
  • "operationalModes": [ ]
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Temperature Controller State

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Temperature Controller State

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
constantTemperature
required
number (Constanttemperature)
tempController
required
string (ID of Associated TempController Block)

Relationship to a TempController block. Reverse key: TempController.tempControllerStates. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

operationalModes
Array of any (IDs of Associated OperationalMode Blocks)
Default: []

Relationship to one or more OperationalMode blocks. Reverse key: OperationalMode.tempControllerStates. On delete: SET_NONE (remove ID of referenced block from this relationship field).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "constantTemperature": 0,
  • "tempController": "string",
  • "operationalModes": [ ]
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

FieldOfView

Create Circular Field of View

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
fieldOfViewType
required
string (Fieldofviewtype)
Value: "CIRC_FIELD_OF_VIEW"
boresightBodyFrameVector
required
string (ID of Associated BodyFrameVector Block)

Relationship to a BodyFrameVector block. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

halfAngle
required
number (Halfangle) [ 0 .. 180 ]

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "fieldOfViewType": "CIRC_FIELD_OF_VIEW",
  • "boresightBodyFrameVector": "string",
  • "halfAngle": 180
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Circular Field of View

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Circular Field of View

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
fieldOfViewType
required
string (Fieldofviewtype)
Value: "CIRC_FIELD_OF_VIEW"
boresightBodyFrameVector
required
string (ID of Associated BodyFrameVector Block)

Relationship to a BodyFrameVector block. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

halfAngle
required
number (Halfangle) [ 0 .. 180 ]

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "fieldOfViewType": "CIRC_FIELD_OF_VIEW",
  • "boresightBodyFrameVector": "string",
  • "halfAngle": 180
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Create Rectangular Field of View

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
fieldOfViewType
required
string (Fieldofviewtype)
Value: "RECT_FIELD_OF_VIEW"
boresightBodyFrameVector
required
string (ID of Associated BodyFrameVector Block)

Relationship to a BodyFrameVector block. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

heightHalfAngle
required
number (Heighthalfangle) [ 0 .. 180 ]
widthHalfAngle
required
number (Widthhalfangle) [ 0 .. 180 ]
heightBodyFrameVector
required
string (ID of Associated BodyFrameVector Block)

Relationship to a BodyFrameVector block. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "fieldOfViewType": "RECT_FIELD_OF_VIEW",
  • "boresightBodyFrameVector": "string",
  • "heightHalfAngle": 180,
  • "widthHalfAngle": 180,
  • "heightBodyFrameVector": "string"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Rectangular Field of View

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Rectangular Field of View

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
fieldOfViewType
required
string (Fieldofviewtype)
Value: "RECT_FIELD_OF_VIEW"
boresightBodyFrameVector
required
string (ID of Associated BodyFrameVector Block)

Relationship to a BodyFrameVector block. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

heightHalfAngle
required
number (Heighthalfangle) [ 0 .. 180 ]
widthHalfAngle
required
number (Widthhalfangle) [ 0 .. 180 ]
heightBodyFrameVector
required
string (ID of Associated BodyFrameVector Block)

Relationship to a BodyFrameVector block. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "fieldOfViewType": "RECT_FIELD_OF_VIEW",
  • "boresightBodyFrameVector": "string",
  • "heightHalfAngle": 180,
  • "widthHalfAngle": 180,
  • "heightBodyFrameVector": "string"
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Surface

Create Surface

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
motionType
required
any (Motion Type)
Enum: "FIXED" "SUN_TRACKING"

An enumeration.

area
required
number (Area [m^2]) > 0
surfaceCentroid
required
Array of numbers (Centroid [Vector3[m]])
bodyFrameVector
required
string (ID of Associated BodyFrameVector Block)

Relationship to a BodyFrameVector block. Reverse key: BodyFrameVector.surfaces. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

surfaceMaterial
required
string (ID of Associated SurfaceMaterial Block)

Relationship to a SurfaceMaterial block. Reverse key: SurfaceMaterial.surfaces. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

satellite
required
string (ID of Associated Satellite Block)

Relationship to a Satellite block. Reverse key: Satellite.surfaces. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "motionType": "FIXED",
  • "area": 0,
  • "surfaceCentroid": [
    ],
  • "bodyFrameVector": "string",
  • "surfaceMaterial": "string",
  • "satellite": "string"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Surface

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Surface

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
motionType
required
any (Motion Type)
Enum: "FIXED" "SUN_TRACKING"

An enumeration.

area
required
number (Area [m^2]) > 0
surfaceCentroid
required
Array of numbers (Centroid [Vector3[m]])
bodyFrameVector
required
string (ID of Associated BodyFrameVector Block)

Relationship to a BodyFrameVector block. Reverse key: BodyFrameVector.surfaces. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

surfaceMaterial
required
string (ID of Associated SurfaceMaterial Block)

Relationship to a SurfaceMaterial block. Reverse key: SurfaceMaterial.surfaces. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "motionType": "FIXED",
  • "area": 0,
  • "surfaceCentroid": [
    ],
  • "bodyFrameVector": "string",
  • "surfaceMaterial": "string"
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Battery Cell

Create Battery Cell

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
partNumber
required
string (Partnumber) <= 32 characters
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
esr
required
number (ESR [ohms])) >= 0
maxChargeCurrent
required
number (Max Charge Current [A]) >= 0
maxDischargeCurrent
required
number (Max Discharge Current [A]) >= 0
minSoc
required
number (Min State of Charge) [ 0 .. 1 ]
curve
required
Array of numbers (SoC vs. Voc Curve) = 2 items [ items[ items >= 0 ] ]

Cell state of charge vs. open-circuit voltage curve. The first list should contain all SoC values in increasing order and the second should contain all Voc values [V]. Each Voc value must be greater than or equal to the prior value.

capacity
required
number (Capacity [A-hr]) >= 0
topology
required
string (ID of Associated Topology Block)

Relationship to a Topology block. Reverse key: Topology.batteryCells. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "string",
  • "manufacturer": "",
  • "esr": 0,
  • "maxChargeCurrent": 0,
  • "maxDischargeCurrent": 0,
  • "minSoc": 1,
  • "curve": [
    ],
  • "capacity": 0,
  • "topology": "string"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Battery Cell

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Battery Cell

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
partNumber
required
string (Partnumber) <= 32 characters
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
esr
required
number (ESR [ohms])) >= 0
maxChargeCurrent
required
number (Max Charge Current [A]) >= 0
maxDischargeCurrent
required
number (Max Discharge Current [A]) >= 0
minSoc
required
number (Min State of Charge) [ 0 .. 1 ]
curve
required
Array of numbers (SoC vs. Voc Curve) = 2 items [ items[ items >= 0 ] ]

Cell state of charge vs. open-circuit voltage curve. The first list should contain all SoC values in increasing order and the second should contain all Voc values [V]. Each Voc value must be greater than or equal to the prior value.

capacity
required
number (Capacity [A-hr]) >= 0

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "string",
  • "manufacturer": "",
  • "esr": 0,
  • "maxChargeCurrent": 0,
  • "maxDischargeCurrent": 0,
  • "minSoc": 1,
  • "curve": [
    ],
  • "capacity": 0
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

PointingMode

Create Passive Pointing Mode

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
pointingModeType
required
string (Pointing Mode Type)
Value: "PASSIVE"
odAlgorithm
string (ID of Associated OrbitDeterminationAlgorithm Block)

Relationship to zero or one OrbitDeterminationAlgorithm blocks. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

adAlgorithm
string (ID of Associated AttitudeDeterminationAlgorithm Block)

Relationship to zero or one AttitudeDeterminationAlgorithm blocks. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

conOps
required
string (ID of Associated ConOps Block)

Relationship to a ConOps block. Reverse key: ConOps.pointingModes. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "pointingModeType": "PASSIVE",
  • "odAlgorithm": "string",
  • "adAlgorithm": "string",
  • "conOps": "string"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Passive Pointing Mode

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Passive Pointing Mode

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
pointingModeType
required
string (Pointing Mode Type)
Value: "PASSIVE"
odAlgorithm
string (ID of Associated OrbitDeterminationAlgorithm Block)

Relationship to zero or one OrbitDeterminationAlgorithm blocks. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

adAlgorithm
string (ID of Associated AttitudeDeterminationAlgorithm Block)

Relationship to zero or one AttitudeDeterminationAlgorithm blocks. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "pointingModeType": "PASSIVE",
  • "odAlgorithm": "string",
  • "adAlgorithm": "string"
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Create Direction Lock Pointing Mode

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
pointingModeType
required
string (Pointing Mode Type)
Value: "LOCK"
odAlgorithm
string (ID of Associated OrbitDeterminationAlgorithm Block)

Relationship to zero or one OrbitDeterminationAlgorithm blocks. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

adAlgorithm
string (ID of Associated AttitudeDeterminationAlgorithm Block)

Relationship to zero or one AttitudeDeterminationAlgorithm blocks. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

conOps
required
string (ID of Associated ConOps Block)

Relationship to a ConOps block. Reverse key: ConOps.pointingModes. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

lockVector
required
string (ID of Associated ReferenceVector Block)

Relationship to a ReferenceVector block. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

lockBodyFrameVector
required
string (ID of Associated BodyFrameVector Block)

Relationship to a BodyFrameVector block. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

acAlgorithm
required
string (ID of Associated AttitudeControlAlgorithm Block)

Relationship to a AttitudeControlAlgorithm block. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

spinRate
required
number (Spinrate)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "pointingModeType": "LOCK",
  • "odAlgorithm": "string",
  • "adAlgorithm": "string",
  • "conOps": "string",
  • "lockVector": "string",
  • "lockBodyFrameVector": "string",
  • "acAlgorithm": "string",
  • "spinRate": 0
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Direction Lock Pointing Mode

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Direction Lock Pointing Mode

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
pointingModeType
required
string (Pointing Mode Type)
Value: "LOCK"
odAlgorithm
string (ID of Associated OrbitDeterminationAlgorithm Block)

Relationship to zero or one OrbitDeterminationAlgorithm blocks. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

adAlgorithm
string (ID of Associated AttitudeDeterminationAlgorithm Block)

Relationship to zero or one AttitudeDeterminationAlgorithm blocks. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

lockVector
required
string (ID of Associated ReferenceVector Block)

Relationship to a ReferenceVector block. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

lockBodyFrameVector
required
string (ID of Associated BodyFrameVector Block)

Relationship to a BodyFrameVector block. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

acAlgorithm
required
string (ID of Associated AttitudeControlAlgorithm Block)

Relationship to a AttitudeControlAlgorithm block. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

spinRate
required
number (Spinrate)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "pointingModeType": "LOCK",
  • "odAlgorithm": "string",
  • "adAlgorithm": "string",
  • "lockVector": "string",
  • "lockBodyFrameVector": "string",
  • "acAlgorithm": "string",
  • "spinRate": 0
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Create Max Secondary Alignment Pointing Mode

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
pointingModeType
required
string (Pointing Mode Type)
Value: "MAX_SECONDARY_ALIGN"
odAlgorithm
string (ID of Associated OrbitDeterminationAlgorithm Block)

Relationship to zero or one OrbitDeterminationAlgorithm blocks. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

adAlgorithm
string (ID of Associated AttitudeDeterminationAlgorithm Block)

Relationship to zero or one AttitudeDeterminationAlgorithm blocks. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

conOps
required
string (ID of Associated ConOps Block)

Relationship to a ConOps block. Reverse key: ConOps.pointingModes. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

lockVector
required
string (ID of Associated ReferenceVector Block)

Relationship to a ReferenceVector block. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

lockBodyFrameVector
required
string (ID of Associated BodyFrameVector Block)

Relationship to a BodyFrameVector block. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

acAlgorithm
required
string (ID of Associated AttitudeControlAlgorithm Block)

Relationship to a AttitudeControlAlgorithm block. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

maxAlignVector
required
string (ID of Associated ReferenceVector Block)

Relationship to a ReferenceVector block. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

maxAlignBodyFrameVector
required
string (ID of Associated BodyFrameVector Block)

Relationship to a BodyFrameVector block. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "pointingModeType": "MAX_SECONDARY_ALIGN",
  • "odAlgorithm": "string",
  • "adAlgorithm": "string",
  • "conOps": "string",
  • "lockVector": "string",
  • "lockBodyFrameVector": "string",
  • "acAlgorithm": "string",
  • "maxAlignVector": "string",
  • "maxAlignBodyFrameVector": "string"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Max Secondary Alignment Pointing Mode

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Max Secondary Alignment Pointing Mode

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
pointingModeType
required
string (Pointing Mode Type)
Value: "MAX_SECONDARY_ALIGN"
odAlgorithm
string (ID of Associated OrbitDeterminationAlgorithm Block)

Relationship to zero or one OrbitDeterminationAlgorithm blocks. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

adAlgorithm
string (ID of Associated AttitudeDeterminationAlgorithm Block)

Relationship to zero or one AttitudeDeterminationAlgorithm blocks. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

lockVector
required
string (ID of Associated ReferenceVector Block)

Relationship to a ReferenceVector block. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

lockBodyFrameVector
required
string (ID of Associated BodyFrameVector Block)

Relationship to a BodyFrameVector block. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

acAlgorithm
required
string (ID of Associated AttitudeControlAlgorithm Block)

Relationship to a AttitudeControlAlgorithm block. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

maxAlignVector
required
string (ID of Associated ReferenceVector Block)

Relationship to a ReferenceVector block. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

maxAlignBodyFrameVector
required
string (ID of Associated BodyFrameVector Block)

Relationship to a BodyFrameVector block. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "pointingModeType": "MAX_SECONDARY_ALIGN",
  • "odAlgorithm": "string",
  • "adAlgorithm": "string",
  • "lockVector": "string",
  • "lockBodyFrameVector": "string",
  • "acAlgorithm": "string",
  • "maxAlignVector": "string",
  • "maxAlignBodyFrameVector": "string"
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Load State

Create Load State

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
efficiency
required
number (Efficiency) [ 0 .. 1 ]
component
required
string (ID of Associated Component Block)

Relationship to a Component block. Reverse key: Component.loadStates. On delete: CASCADE (delete this block when referenced block is deleted).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "efficiency": 1,
  • "component": "string"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Load State

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Load State

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
efficiency
required
number (Efficiency) [ 0 .. 1 ]
operationalModes
Array of any (IDs of Associated OperationalMode Blocks)
Default: []

Relationship to one or more OperationalMode blocks. Reverse key: OperationalMode.loadStates. On delete: SET_NONE (remove ID of referenced block from this relationship field).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "efficiency": 1,
  • "operationalModes": [ ]
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Thermal Interface Material

Create Thermal Interface Material

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
partNumber
string (Part Number) <= 32 characters
Default: ""
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
resistivity
required
number (Resistivity) > 0
thickness
required
number (Thickness) > 0
hotTempRating
required
number (Hottemprating)
coldTempRating
required
number (Coldtemprating)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "",
  • "manufacturer": "",
  • "resistivity": 0,
  • "thickness": 0,
  • "hotTempRating": 0,
  • "coldTempRating": 0
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Thermal Interface Material

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Thermal Interface Material

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
partNumber
string (Part Number) <= 32 characters
Default: ""
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
resistivity
required
number (Resistivity) > 0
thickness
required
number (Thickness) > 0
hotTempRating
required
number (Hottemprating)
coldTempRating
required
number (Coldtemprating)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "",
  • "manufacturer": "",
  • "resistivity": 0,
  • "thickness": 0,
  • "hotTempRating": 0,
  • "coldTempRating": 0
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Temperature Controller

Create Heater

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
partNumber
string (Part Number) <= 32 characters
Default: ""
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
name
required
string (Name) <= 32 characters
hotTempRating
number (Hottemprating)
Default: 0
coldTempRating
number (Coldtemprating)
Default: 0
thermalCapacitance
number (Thermalcapacitance) >= 0
Default: 1
temperature
number (Temperature)
Default: 273.15
onRegHeatFlowRate
required
number (Onregheatflowrate) > 0
controlledComponent
required
string (ID of Associated Component Block)

Relationship to a Component block. Reverse key: Component.tempControllers. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "",
  • "manufacturer": "",
  • "name": "string",
  • "hotTempRating": 0,
  • "coldTempRating": 0,
  • "thermalCapacitance": 1,
  • "temperature": 273.15,
  • "onRegHeatFlowRate": 0,
  • "controlledComponent": "string"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Heater

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Heater

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
partNumber
string (Part Number) <= 32 characters
Default: ""
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
name
required
string (Name) <= 32 characters
hotTempRating
number (Hottemprating)
Default: 0
coldTempRating
number (Coldtemprating)
Default: 0
thermalCapacitance
number (Thermalcapacitance) >= 0
Default: 1
temperature
number (Temperature)
Default: 273.15
onRegHeatFlowRate
required
number (Onregheatflowrate) > 0
controlledComponent
required
string (ID of Associated Component Block)

Relationship to a Component block. Reverse key: Component.tempControllers. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "",
  • "manufacturer": "",
  • "name": "string",
  • "hotTempRating": 0,
  • "coldTempRating": 0,
  • "thermalCapacitance": 1,
  • "temperature": 273.15,
  • "onRegHeatFlowRate": 0,
  • "controlledComponent": "string"
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Create Cooler

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
partNumber
string (Part Number) <= 32 characters
Default: ""
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
name
required
string (Name) <= 32 characters
hotTempRating
number (Hottemprating)
Default: 0
coldTempRating
number (Coldtemprating)
Default: 0
thermalCapacitance
number (Thermalcapacitance) >= 0
Default: 1
temperature
number (Temperature)
Default: 273.15
onRegHeatFlowRate
required
number (Onregheatflowrate) > 0
controlledComponent
required
string (ID of Associated Component Block)

Relationship to a Component block. Reverse key: Component.tempControllers. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

efficiency
required
number (Efficiency) [ 0 .. 1 ]

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "",
  • "manufacturer": "",
  • "name": "string",
  • "hotTempRating": 0,
  • "coldTempRating": 0,
  • "thermalCapacitance": 1,
  • "temperature": 273.15,
  • "onRegHeatFlowRate": 0,
  • "controlledComponent": "string",
  • "efficiency": 1
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Cooler

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Cooler

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
partNumber
string (Part Number) <= 32 characters
Default: ""
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
name
required
string (Name) <= 32 characters
hotTempRating
number (Hottemprating)
Default: 0
coldTempRating
number (Coldtemprating)
Default: 0
thermalCapacitance
number (Thermalcapacitance) >= 0
Default: 1
temperature
number (Temperature)
Default: 273.15
onRegHeatFlowRate
required
number (Onregheatflowrate) > 0
controlledComponent
required
string (ID of Associated Component Block)

Relationship to a Component block. Reverse key: Component.tempControllers. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

efficiency
required
number (Efficiency) [ 0 .. 1 ]

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "",
  • "manufacturer": "",
  • "name": "string",
  • "hotTempRating": 0,
  • "coldTempRating": 0,
  • "thermalCapacitance": 1,
  • "temperature": 273.15,
  • "onRegHeatFlowRate": 0,
  • "controlledComponent": "string",
  • "efficiency": 1
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Target Group

Create Target Group

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
targetType
required
any (Target Type)
Enum: "SPACE_TARGET" "CELESTIAL_TARGET" "GROUND_TARGET"

An enumeration.

conOps
required
string (ID of Associated ConOps Block)

Relationship to a ConOps block. Reverse key: ConOps.targetGroups. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "targetType": "SPACE_TARGET",
  • "conOps": "string"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Target Group

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Target Group

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
targetAssociations
object (IDs of Associated Target Blocks)
Default: {}

Relationship with data to one or more Target blocks. On delete: SET_NONE (remove ID of referenced block from this relationship field).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "targetAssociations": { }
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Body Frame Vector

Create Body Frame Vector

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
definitionType
required
any (Definition Type)
Enum: "SPHERICAL_ANGLES" "VECTOR"

An enumeration.

required
SphericalAngles (object) or Vector (object) (Definition Parameters)
satellite
required
string (ID of Associated Satellite Block)

Relationship to a Satellite block. Reverse key: Satellite.bodyFrameVectors. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "definitionType": "SPHERICAL_ANGLES",
  • "definitionParams": {
    },
  • "satellite": "string"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Body Frame Vector

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Body Frame Vector

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
definitionType
required
any (Definition Type)
Enum: "SPHERICAL_ANGLES" "VECTOR"

An enumeration.

required
SphericalAngles (object) or Vector (object) (Definition Parameters)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "definitionType": "SPHERICAL_ANGLES",
  • "definitionParams": {
    }
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Component

Create Component

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
partNumber
string (Part Number) <= 32 characters
Default: ""
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
name
required
string (Name) <= 32 characters
hotTempRating
number (Hottemprating)
Default: 0
coldTempRating
number (Coldtemprating)
Default: 0
thermalCapacitance
number (Thermalcapacitance) >= 0
Default: 1
temperature
number (Temperature)
Default: 273.15
subsystem
required
string (ID of Associated Subsystem Block)

Relationship to a Subsystem block. Reverse key: Subsystem.components. On delete: CASCADE (delete this block when referenced block is deleted).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "",
  • "manufacturer": "",
  • "name": "string",
  • "hotTempRating": 0,
  • "coldTempRating": 0,
  • "thermalCapacitance": 1,
  • "temperature": 273.15,
  • "subsystem": "string"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Component

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Component

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
partNumber
string (Part Number) <= 32 characters
Default: ""
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
name
required
string (Name) <= 32 characters
hotTempRating
number (Hottemprating)
Default: 0
coldTempRating
number (Coldtemprating)
Default: 0
thermalCapacitance
number (Thermalcapacitance) >= 0
Default: 1
temperature
number (Temperature)
Default: 273.15

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "",
  • "manufacturer": "",
  • "name": "string",
  • "hotTempRating": 0,
  • "coldTempRating": 0,
  • "thermalCapacitance": 1,
  • "temperature": 273.15
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Create Solar Panel

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
partNumber
string (Part Number) <= 32 characters
Default: ""
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
name
required
string (Name) <= 32 characters
hotTempRating
number (Hottemprating)
Default: 0
coldTempRating
number (Coldtemprating)
Default: 0
thermalCapacitance
number (Thermalcapacitance) >= 0
Default: 1
temperature
number (Temperature)
Default: 273.15
subsystem
required
string (ID of Associated Subsystem Block)

Relationship to a Subsystem block. Reverse key: Subsystem.components. On delete: CASCADE (delete this block when referenced block is deleted).

numSeries
required
integer (# of Series Cells) >= 1
numParallel
required
integer (# of Parallel Cells) >= 1
blockingDiodeDrop
required
number (Blocking Diode Drop [V]) >= 0

Set to 0 to omit diode.

cell
required
string (ID of Associated SolarCell Block)

Relationship to a SolarCell block. Reverse key: SolarCell.panels. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

surface
required
string (ID of Associated Surface Block)

Relationship to a Surface block. Reverse key: Surface.panels. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "",
  • "manufacturer": "",
  • "name": "string",
  • "hotTempRating": 0,
  • "coldTempRating": 0,
  • "thermalCapacitance": 1,
  • "temperature": 273.15,
  • "subsystem": "string",
  • "numSeries": 1,
  • "numParallel": 1,
  • "blockingDiodeDrop": 0,
  • "cell": "string",
  • "surface": "string"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Solar Panel

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Solar Panel

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
partNumber
string (Part Number) <= 32 characters
Default: ""
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
name
required
string (Name) <= 32 characters
hotTempRating
number (Hottemprating)
Default: 0
coldTempRating
number (Coldtemprating)
Default: 0
thermalCapacitance
number (Thermalcapacitance) >= 0
Default: 1
temperature
number (Temperature)
Default: 273.15
numSeries
required
integer (# of Series Cells) >= 1
numParallel
required
integer (# of Parallel Cells) >= 1
blockingDiodeDrop
required
number (Blocking Diode Drop [V]) >= 0

Set to 0 to omit diode.

cell
required
string (ID of Associated SolarCell Block)

Relationship to a SolarCell block. Reverse key: SolarCell.panels. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

surface
required
string (ID of Associated Surface Block)

Relationship to a Surface block. Reverse key: Surface.panels. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "",
  • "manufacturer": "",
  • "name": "string",
  • "hotTempRating": 0,
  • "coldTempRating": 0,
  • "thermalCapacitance": 1,
  • "temperature": 273.15,
  • "numSeries": 1,
  • "numParallel": 1,
  • "blockingDiodeDrop": 0,
  • "cell": "string",
  • "surface": "string"
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Create Battery Pack

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
partNumber
string (Part Number) <= 32 characters
Default: ""
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
name
required
string (Name) <= 32 characters
hotTempRating
number (Hottemprating)
Default: 0
coldTempRating
number (Coldtemprating)
Default: 0
thermalCapacitance
number (Thermalcapacitance) >= 0
Default: 1
temperature
number (Temperature)
Default: 273.15
subsystem
required
string (ID of Associated Subsystem Block)

Relationship to a Subsystem block. Reverse key: Subsystem.components. On delete: CASCADE (delete this block when referenced block is deleted).

numSeries
required
integer (# of Series Cells) >= 1
numParallel
required
integer (# of Parallel Cells) >= 1
cell
required
string (ID of Associated BatteryCell Block)

Relationship to a BatteryCell block. Reverse key: BatteryCell.packs. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

battery
required
string (ID of Associated Battery Block)

Relationship to a Battery block. Reverse key: Battery.packs. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "",
  • "manufacturer": "",
  • "name": "string",
  • "hotTempRating": 0,
  • "coldTempRating": 0,
  • "thermalCapacitance": 1,
  • "temperature": 273.15,
  • "subsystem": "string",
  • "numSeries": 1,
  • "numParallel": 1,
  • "cell": "string",
  • "battery": "string"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Battery Pack

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Battery Pack

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
partNumber
string (Part Number) <= 32 characters
Default: ""
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
name
required
string (Name) <= 32 characters
hotTempRating
number (Hottemprating)
Default: 0
coldTempRating
number (Coldtemprating)
Default: 0
thermalCapacitance
number (Thermalcapacitance) >= 0
Default: 1
temperature
number (Temperature)
Default: 273.15
numSeries
required
integer (# of Series Cells) >= 1
numParallel
required
integer (# of Parallel Cells) >= 1
cell
required
string (ID of Associated BatteryCell Block)

Relationship to a BatteryCell block. Reverse key: BatteryCell.packs. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "",
  • "manufacturer": "",
  • "name": "string",
  • "hotTempRating": 0,
  • "coldTempRating": 0,
  • "thermalCapacitance": 1,
  • "temperature": 273.15,
  • "numSeries": 1,
  • "numParallel": 1,
  • "cell": "string"
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Update Topology

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
partNumber
string (Part Number) <= 32 characters
Default: ""
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
name
required
string (Name) <= 32 characters
hotTempRating
number (Hottemprating)
Default: 0
coldTempRating
number (Coldtemprating)
Default: 0
thermalCapacitance
number (Thermalcapacitance) >= 0
Default: 1
temperature
number (Temperature)
Default: 273.15
required
Topology Type (string) or TopologyTypes (any) (Topology Type)

This field may only be '' initially. It is required on first update.

TopologyParamFRD (object) or TopologyParamSCH (object) or TopologyParamQRD (object) or TopologyParamTCM (object) or TopologyParamSCM (object) (Topology Definition Parameters)

This field may only be undefined initially. It is required on first update.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "",
  • "manufacturer": "",
  • "name": "string",
  • "hotTempRating": 0,
  • "coldTempRating": 0,
  • "thermalCapacitance": 1,
  • "temperature": 273.15,
  • "topologyType": "",
  • "topologyParams": {
    }
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Create Direction Sensor

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
partNumber
string (Part Number) <= 32 characters
Default: ""
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
name
required
string (Name) <= 32 characters
hotTempRating
number (Hottemprating)
Default: 0
coldTempRating
number (Coldtemprating)
Default: 0
thermalCapacitance
number (Thermalcapacitance) >= 0
Default: 1
temperature
number (Temperature)
Default: 273.15
fieldOfView
string (ID of Associated FieldOfView Block)

Relationship to zero or one FieldOfView blocks. Reverse key: FieldOfView.sensors. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

oneSigmaAngleError
required
number (Onesigmaangleerror)
referenceVector
required
string (ID of Associated ReferenceVector Block)

Relationship to a ReferenceVector block. Reverse key: ReferenceVector.directionSensors. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "",
  • "manufacturer": "",
  • "name": "string",
  • "hotTempRating": 0,
  • "coldTempRating": 0,
  • "thermalCapacitance": 1,
  • "temperature": 273.15,
  • "fieldOfView": "string",
  • "oneSigmaAngleError": 0,
  • "referenceVector": "string"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Direction Sensor

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Direction Sensor

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
partNumber
string (Part Number) <= 32 characters
Default: ""
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
name
required
string (Name) <= 32 characters
hotTempRating
number (Hottemprating)
Default: 0
coldTempRating
number (Coldtemprating)
Default: 0
thermalCapacitance
number (Thermalcapacitance) >= 0
Default: 1
temperature
number (Temperature)
Default: 273.15
fieldOfView
string (ID of Associated FieldOfView Block)

Relationship to zero or one FieldOfView blocks. Reverse key: FieldOfView.sensors. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

oneSigmaAngleError
required
number (Onesigmaangleerror)
referenceVector
required
string (ID of Associated ReferenceVector Block)

Relationship to a ReferenceVector block. Reverse key: ReferenceVector.directionSensors. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "",
  • "manufacturer": "",
  • "name": "string",
  • "hotTempRating": 0,
  • "coldTempRating": 0,
  • "thermalCapacitance": 1,
  • "temperature": 273.15,
  • "fieldOfView": "string",
  • "oneSigmaAngleError": 0,
  • "referenceVector": "string"
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Create Vector Sensor

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
partNumber
string (Part Number) <= 32 characters
Default: ""
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
name
required
string (Name) <= 32 characters
hotTempRating
number (Hottemprating)
Default: 0
coldTempRating
number (Coldtemprating)
Default: 0
thermalCapacitance
number (Thermalcapacitance) >= 0
Default: 1
temperature
number (Temperature)
Default: 273.15
fieldOfView
string (ID of Associated FieldOfView Block)

Relationship to zero or one FieldOfView blocks. Reverse key: FieldOfView.sensors. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

oneSigmaPerAxisError
required
number (Onesigmaperaxiserror)
referenceVector
required
string (ID of Associated ReferenceVector Block)

Relationship to a ReferenceVector block. Reverse key: ReferenceVector.vectorSensors. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "",
  • "manufacturer": "",
  • "name": "string",
  • "hotTempRating": 0,
  • "coldTempRating": 0,
  • "thermalCapacitance": 1,
  • "temperature": 273.15,
  • "fieldOfView": "string",
  • "oneSigmaPerAxisError": 0,
  • "referenceVector": "string"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Vector Sensor

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Vector Sensor

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
partNumber
string (Part Number) <= 32 characters
Default: ""
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
name
required
string (Name) <= 32 characters
hotTempRating
number (Hottemprating)
Default: 0
coldTempRating
number (Coldtemprating)
Default: 0
thermalCapacitance
number (Thermalcapacitance) >= 0
Default: 1
temperature
number (Temperature)
Default: 273.15
fieldOfView
string (ID of Associated FieldOfView Block)

Relationship to zero or one FieldOfView blocks. Reverse key: FieldOfView.sensors. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

oneSigmaPerAxisError
required
number (Onesigmaperaxiserror)
referenceVector
required
string (ID of Associated ReferenceVector Block)

Relationship to a ReferenceVector block. Reverse key: ReferenceVector.vectorSensors. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "",
  • "manufacturer": "",
  • "name": "string",
  • "hotTempRating": 0,
  • "coldTempRating": 0,
  • "thermalCapacitance": 1,
  • "temperature": 273.15,
  • "fieldOfView": "string",
  • "oneSigmaPerAxisError": 0,
  • "referenceVector": "string"
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Create Optical Attitude Sensor

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
partNumber
string (Part Number) <= 32 characters
Default: ""
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
name
required
string (Name) <= 32 characters
hotTempRating
number (Hottemprating)
Default: 0
coldTempRating
number (Coldtemprating)
Default: 0
thermalCapacitance
number (Thermalcapacitance) >= 0
Default: 1
temperature
number (Temperature)
Default: 273.15
fieldOfView
string (ID of Associated FieldOfView Block)

Relationship to zero or one FieldOfView blocks. Reverse key: FieldOfView.sensors. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

oneSigmaCrossAxisError
required
number (Onesigmacrossaxiserror)
oneSigmaBoresightAxisError
required
number (Onesigmaboresightaxiserror)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "",
  • "manufacturer": "",
  • "name": "string",
  • "hotTempRating": 0,
  • "coldTempRating": 0,
  • "thermalCapacitance": 1,
  • "temperature": 273.15,
  • "fieldOfView": "string",
  • "oneSigmaCrossAxisError": 0,
  • "oneSigmaBoresightAxisError": 0
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Optical Attitude Sensor

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Optical Attitude Sensor

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
partNumber
string (Part Number) <= 32 characters
Default: ""
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
name
required
string (Name) <= 32 characters
hotTempRating
number (Hottemprating)
Default: 0
coldTempRating
number (Coldtemprating)
Default: 0
thermalCapacitance
number (Thermalcapacitance) >= 0
Default: 1
temperature
number (Temperature)
Default: 273.15
fieldOfView
string (ID of Associated FieldOfView Block)

Relationship to zero or one FieldOfView blocks. Reverse key: FieldOfView.sensors. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

oneSigmaCrossAxisError
required
number (Onesigmacrossaxiserror)
oneSigmaBoresightAxisError
required
number (Onesigmaboresightaxiserror)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "",
  • "manufacturer": "",
  • "name": "string",
  • "hotTempRating": 0,
  • "coldTempRating": 0,
  • "thermalCapacitance": 1,
  • "temperature": 273.15,
  • "fieldOfView": "string",
  • "oneSigmaCrossAxisError": 0,
  • "oneSigmaBoresightAxisError": 0
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Create PositionSensor

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
partNumber
string (Part Number) <= 32 characters
Default: ""
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
name
required
string (Name) <= 32 characters
hotTempRating
number (Hottemprating)
Default: 0
coldTempRating
number (Coldtemprating)
Default: 0
thermalCapacitance
number (Thermalcapacitance) >= 0
Default: 1
temperature
number (Temperature)
Default: 273.15
fieldOfView
string (ID of Associated FieldOfView Block)

Relationship to zero or one FieldOfView blocks. Reverse key: FieldOfView.sensors. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

oneSigmaDistanceError
required
number (Onesigmadistanceerror)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "",
  • "manufacturer": "",
  • "name": "string",
  • "hotTempRating": 0,
  • "coldTempRating": 0,
  • "thermalCapacitance": 1,
  • "temperature": 273.15,
  • "fieldOfView": "string",
  • "oneSigmaDistanceError": 0
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete PositionSensor

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update PositionSensor

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
partNumber
string (Part Number) <= 32 characters
Default: ""
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
name
required
string (Name) <= 32 characters
hotTempRating
number (Hottemprating)
Default: 0
coldTempRating
number (Coldtemprating)
Default: 0
thermalCapacitance
number (Thermalcapacitance) >= 0
Default: 1
temperature
number (Temperature)
Default: 273.15
fieldOfView
string (ID of Associated FieldOfView Block)

Relationship to zero or one FieldOfView blocks. Reverse key: FieldOfView.sensors. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

oneSigmaDistanceError
required
number (Onesigmadistanceerror)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "",
  • "manufacturer": "",
  • "name": "string",
  • "hotTempRating": 0,
  • "coldTempRating": 0,
  • "thermalCapacitance": 1,
  • "temperature": 273.15,
  • "fieldOfView": "string",
  • "oneSigmaDistanceError": 0
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Create Angular Velocity Sensor

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
partNumber
string (Part Number) <= 32 characters
Default: ""
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
name
required
string (Name) <= 32 characters
hotTempRating
number (Hottemprating)
Default: 0
coldTempRating
number (Coldtemprating)
Default: 0
thermalCapacitance
number (Thermalcapacitance) >= 0
Default: 1
temperature
number (Temperature)
Default: 273.15
fieldOfView
string (ID of Associated FieldOfView Block)

Relationship to zero or one FieldOfView blocks. Reverse key: FieldOfView.sensors. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

oneSigmaPerAxisError
required
number (Onesigmaperaxiserror)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "",
  • "manufacturer": "",
  • "name": "string",
  • "hotTempRating": 0,
  • "coldTempRating": 0,
  • "thermalCapacitance": 1,
  • "temperature": 273.15,
  • "fieldOfView": "string",
  • "oneSigmaPerAxisError": 0
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Angular Velocity Sensor

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Angular Velocity Sensor

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
partNumber
string (Part Number) <= 32 characters
Default: ""
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
name
required
string (Name) <= 32 characters
hotTempRating
number (Hottemprating)
Default: 0
coldTempRating
number (Coldtemprating)
Default: 0
thermalCapacitance
number (Thermalcapacitance) >= 0
Default: 1
temperature
number (Temperature)
Default: 273.15
fieldOfView
string (ID of Associated FieldOfView Block)

Relationship to zero or one FieldOfView blocks. Reverse key: FieldOfView.sensors. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

oneSigmaPerAxisError
required
number (Onesigmaperaxiserror)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "",
  • "manufacturer": "",
  • "name": "string",
  • "hotTempRating": 0,
  • "coldTempRating": 0,
  • "thermalCapacitance": 1,
  • "temperature": 273.15,
  • "fieldOfView": "string",
  • "oneSigmaPerAxisError": 0
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Create Magnetorquer

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
partNumber
string (Part Number) <= 32 characters
Default: ""
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
name
required
string (Name) <= 32 characters
hotTempRating
number (Hottemprating)
Default: 0
coldTempRating
number (Coldtemprating)
Default: 0
thermalCapacitance
number (Thermalcapacitance) >= 0
Default: 1
temperature
number (Temperature)
Default: 273.15
bodyFrameVector
required
string (ID of Associated BodyFrameVector Block)

Relationship to a BodyFrameVector block. Reverse key: BodyFrameVector.actuators. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

ratedMagneticMoment
required
number (Ratedmagneticmoment) >= 0
powerAtRatedMagneticMoment
required
number (Poweratratedmagneticmoment)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "",
  • "manufacturer": "",
  • "name": "string",
  • "hotTempRating": 0,
  • "coldTempRating": 0,
  • "thermalCapacitance": 1,
  • "temperature": 273.15,
  • "bodyFrameVector": "string",
  • "ratedMagneticMoment": 0,
  • "powerAtRatedMagneticMoment": 0
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Magnetorquer

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Magnetorquer

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
partNumber
string (Part Number) <= 32 characters
Default: ""
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
name
required
string (Name) <= 32 characters
hotTempRating
number (Hottemprating)
Default: 0
coldTempRating
number (Coldtemprating)
Default: 0
thermalCapacitance
number (Thermalcapacitance) >= 0
Default: 1
temperature
number (Temperature)
Default: 273.15
bodyFrameVector
required
string (ID of Associated BodyFrameVector Block)

Relationship to a BodyFrameVector block. Reverse key: BodyFrameVector.actuators. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

ratedMagneticMoment
required
number (Ratedmagneticmoment) >= 0
powerAtRatedMagneticMoment
required
number (Poweratratedmagneticmoment)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "",
  • "manufacturer": "",
  • "name": "string",
  • "hotTempRating": 0,
  • "coldTempRating": 0,
  • "thermalCapacitance": 1,
  • "temperature": 273.15,
  • "bodyFrameVector": "string",
  • "ratedMagneticMoment": 0,
  • "powerAtRatedMagneticMoment": 0
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Create Reaction Wheel

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
partNumber
string (Part Number) <= 32 characters
Default: ""
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
name
required
string (Name) <= 32 characters
hotTempRating
number (Hottemprating)
Default: 0
coldTempRating
number (Coldtemprating)
Default: 0
thermalCapacitance
number (Thermalcapacitance) >= 0
Default: 1
temperature
number (Temperature)
Default: 273.15
bodyFrameVector
required
string (ID of Associated BodyFrameVector Block)

Relationship to a BodyFrameVector block. Reverse key: BodyFrameVector.actuators. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

inertia
required
number (Inertia) >= 0
ratedMomentum
required
number (Ratedmomentum) >= 0
ratedTorque
required
number (Ratedtorque) >= 0
efficiency
required
number (Efficiency) [ 0 .. 1 ]

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "",
  • "manufacturer": "",
  • "name": "string",
  • "hotTempRating": 0,
  • "coldTempRating": 0,
  • "thermalCapacitance": 1,
  • "temperature": 273.15,
  • "bodyFrameVector": "string",
  • "inertia": 0,
  • "ratedMomentum": 0,
  • "ratedTorque": 0,
  • "efficiency": 1
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Reaction Wheel

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Reaction Wheel

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
partNumber
string (Part Number) <= 32 characters
Default: ""
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
name
required
string (Name) <= 32 characters
hotTempRating
number (Hottemprating)
Default: 0
coldTempRating
number (Coldtemprating)
Default: 0
thermalCapacitance
number (Thermalcapacitance) >= 0
Default: 1
temperature
number (Temperature)
Default: 273.15
bodyFrameVector
required
string (ID of Associated BodyFrameVector Block)

Relationship to a BodyFrameVector block. Reverse key: BodyFrameVector.actuators. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

inertia
required
number (Inertia) >= 0
ratedMomentum
required
number (Ratedmomentum) >= 0
ratedTorque
required
number (Ratedtorque) >= 0
efficiency
required
number (Efficiency) [ 0 .. 1 ]

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "",
  • "manufacturer": "",
  • "name": "string",
  • "hotTempRating": 0,
  • "coldTempRating": 0,
  • "thermalCapacitance": 1,
  • "temperature": 273.15,
  • "bodyFrameVector": "string",
  • "inertia": 0,
  • "ratedMomentum": 0,
  • "ratedTorque": 0,
  • "efficiency": 1
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Solar Cell

Create Solar Cell

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
partNumber
string (Part Number) <= 32 characters
Default: ""
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
openCircuitVoltage
required
number (Open Circuit Voltage [V]) >= 0
shortCircuitCurrent
required
number (Short Circuit Current [A]) >= 0
maxPowerVoltage
required
number (Max Power Voltage [V]) >= 0
maxPowerCurrent
required
number (Max Power Current [A]) >= 0
numJunctions
required
integer (# of Junctions) >= 1
topology
required
string (ID of Associated Topology Block)

Relationship to a Topology block. Reverse key: Topology.solarCells. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "",
  • "manufacturer": "",
  • "openCircuitVoltage": 0,
  • "shortCircuitCurrent": 0,
  • "maxPowerVoltage": 0,
  • "maxPowerCurrent": 0,
  • "numJunctions": 1,
  • "topology": "string"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Solar Cell

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Solar Cell

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
partNumber
string (Part Number) <= 32 characters
Default: ""
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
openCircuitVoltage
required
number (Open Circuit Voltage [V]) >= 0
shortCircuitCurrent
required
number (Short Circuit Current [A]) >= 0
maxPowerVoltage
required
number (Max Power Voltage [V]) >= 0
maxPowerCurrent
required
number (Max Power Current [A]) >= 0
numJunctions
required
integer (# of Junctions) >= 1

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "",
  • "manufacturer": "",
  • "openCircuitVoltage": 0,
  • "shortCircuitCurrent": 0,
  • "maxPowerVoltage": 0,
  • "maxPowerCurrent": 0,
  • "numJunctions": 1
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Orbit

Update Orbit

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
initialStateDefType
string (Initial State Definition Type)
Default: ""
Enum: "ORBITAL_ELEMENTS" "REF_ORBIT" "ECI_STATE" "TLE" ""

An enumeration.

ISDPOrbitalElements (object) or ISDPTle (object) or ISDPEci (object) or IROIss (object) or IROGeostat (object) or IROGeostatTransfer (object) or IROPolarCirc (object) or IROEquatorialCirc (object) or IROSunSyncCirc (object) (Initial State Definition Parameters)

May only be null initially.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "initialStateDefType": "",
  • "initialStateDefParams": {
    }
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Field of View Constraint

Create Field of View Constraint

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
keepout
required
boolean (Keepout)
destructive
required
boolean (Destructive)
referenceVector
required
string (ID of Associated ReferenceVector Block)

Relationship to a ReferenceVector block. Reverse key: ReferenceVector.FOVConstraints. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

fieldOfView
required
string (ID of Associated FieldOfView Block)

Relationship to a FieldOfView block. Reverse key: FieldOfView.constraints. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "keepout": true,
  • "destructive": true,
  • "referenceVector": "string",
  • "fieldOfView": "string"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Field of View Constraint

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Field of View Constraint

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
keepout
required
boolean (Keepout)
destructive
required
boolean (Destructive)
referenceVector
required
string (ID of Associated ReferenceVector Block)

Relationship to a ReferenceVector block. Reverse key: ReferenceVector.FOVConstraints. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

fieldOfView
required
string (ID of Associated FieldOfView Block)

Relationship to a FieldOfView block. Reverse key: FieldOfView.constraints. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "keepout": true,
  • "destructive": true,
  • "referenceVector": "string",
  • "fieldOfView": "string"
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Surface Material

Create Surface Material

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
partNumber
string (Part Number) <= 32 characters
Default: ""
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
irEmissivity
required
number (IR Emissivity) [ 0 .. 1 ]
solarAbsorptivity
required
number (Solar Absorptivity) [ 0 .. 1 ]
diffuseSolarReflectivity
required
number (Diffuse Solar Reflectivity) [ 0 .. 1 ]
specularSolarReflectivity
required
number (Specular Solar Reflectivity) [ 0 .. 1 ]
hotTempRating
required
number (Hot Temperature Rating [C])
coldTempRating
required
number (Cold Temperature Rating [C])

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "",
  • "manufacturer": "",
  • "irEmissivity": 1,
  • "solarAbsorptivity": 1,
  • "diffuseSolarReflectivity": 1,
  • "specularSolarReflectivity": 1,
  • "hotTempRating": 0,
  • "coldTempRating": 0
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Surface Material

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Surface Material

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
partNumber
string (Part Number) <= 32 characters
Default: ""
manufacturer
string (Manufacturer) <= 32 characters
Default: ""
irEmissivity
required
number (IR Emissivity) [ 0 .. 1 ]
solarAbsorptivity
required
number (Solar Absorptivity) [ 0 .. 1 ]
diffuseSolarReflectivity
required
number (Diffuse Solar Reflectivity) [ 0 .. 1 ]
specularSolarReflectivity
required
number (Specular Solar Reflectivity) [ 0 .. 1 ]
hotTempRating
required
number (Hot Temperature Rating [C])
coldTempRating
required
number (Cold Temperature Rating [C])

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNumber": "",
  • "manufacturer": "",
  • "irEmissivity": 1,
  • "solarAbsorptivity": 1,
  • "diffuseSolarReflectivity": 1,
  • "specularSolarReflectivity": 1,
  • "hotTempRating": 0,
  • "coldTempRating": 0
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Subsystem

Create Subsystem

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
satellite
required
string (ID of Associated Satellite Block)

Relationship to a Satellite block. Reverse key: Satellite.subsystems. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "satellite": "string"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Subsystem

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Subsystem

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Battery

Update Battery

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
required
Cell Configuration Type (string) or ConfigurationTypes (any) (Cell Configuration Type)
initialSoc
required
number (Initial SoC) [ 0 .. 1 ]

This field may only be null when first created.

maxChargeCurrentOverride
required
number (Max Charge Current Override) >= 0

If null, the max charge current will be computed from the cell-pack composition.

maxDischargeCurrentOverride
required
number (Max Discharge Current Override) >= 0

If null, the max discharge current will be computed from the cell-pack composition.

minSocOverride
required
number (Min SoC Override) [ 0 .. 1 ]

If null, the min state of charge will be computed from the cell-pack composition.

Responses

Request samples

Content type
application/json
{
  • "configurationType": "",
  • "initialSoc": 1,
  • "maxChargeCurrentOverride": 0,
  • "maxDischargeCurrentOverride": 0,
  • "minSocOverride": 1
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

ReferenceVector

Create Local Vector

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
vectorType
required
string (Vectortype)
Value: "LOCAL"
localPointingDirection
required
any (LocalPointingDirections)
Enum: "NADIR" "ZENITH" "CROSS_TRACK_POS" "CROSS_TRACK_NEG" "ALONG_TRACK_POS" "ALONG_TRACK_NEG" "RAM" "ANTI_RAM" "MAGNETIC_FIELD" ""

An enumeration.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "vectorType": "LOCAL",
  • "localPointingDirection": "NADIR"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Local Vector

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Local Vector

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
vectorType
required
string (Vectortype)
Value: "LOCAL"
localPointingDirection
required
any (LocalPointingDirections)
Enum: "NADIR" "ZENITH" "CROSS_TRACK_POS" "CROSS_TRACK_NEG" "ALONG_TRACK_POS" "ALONG_TRACK_NEG" "RAM" "ANTI_RAM" "MAGNETIC_FIELD" ""

An enumeration.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "vectorType": "LOCAL",
  • "localPointingDirection": "NADIR"
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Create Celestial Vector

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
vectorType
required
string (Vectortype)
Value: "CELESTIAL"
celestialPointingDirection
required
any (CelestialPointingDirections)
Enum: "SUN" "MOON" "EARTH"

An enumeration.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "vectorType": "CELESTIAL",
  • "celestialPointingDirection": "SUN"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Celestial Vector

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Celestial Vector

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
vectorType
required
string (Vectortype)
Value: "CELESTIAL"
celestialPointingDirection
required
any (CelestialPointingDirections)
Enum: "SUN" "MOON" "EARTH"

An enumeration.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "vectorType": "CELESTIAL",
  • "celestialPointingDirection": "SUN"
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Create Target Vector

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
vectorType
required
string (Vectortype)
Value: "TARGET"
targetPointingDirection
required
any (TargetPointingDirections)
Enum: "TARGET" "TARGET_GROUP"

An enumeration.

target
string (ID of Associated Target Block)

Relationship to zero or one Target blocks. Reverse key: Target.targetVectors. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

targetGroup
string (ID of Associated TargetGroup Block)

Relationship to zero or one TargetGroup blocks. Reverse key: TargetGroup.targetVectors. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "vectorType": "TARGET",
  • "targetPointingDirection": "TARGET",
  • "target": "string",
  • "targetGroup": "string"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Target Vector

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Target Vector

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
vectorType
required
string (Vectortype)
Value: "TARGET"
targetPointingDirection
required
any (TargetPointingDirections)
Enum: "TARGET" "TARGET_GROUP"

An enumeration.

target
string (ID of Associated Target Block)

Relationship to zero or one Target blocks. Reverse key: Target.targetVectors. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

targetGroup
string (ID of Associated TargetGroup Block)

Relationship to zero or one TargetGroup blocks. Reverse key: TargetGroup.targetVectors. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "vectorType": "TARGET",
  • "targetPointingDirection": "TARGET",
  • "target": "string",
  • "targetGroup": "string"
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Satellite

Update Satellite

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
mass
number (Mass [kg]) > 0
inertia
any (Inertia Matrix [Matrix3[kg-m^2]])
earthshineIrradiance
number (Earthshineirradiance)
albedo
number (Albedo) [ 0 .. 1 ]
dragTorque
Array of numbers (Dragtorque)
gravityGradientTorque
Array of numbers (Gravitygradienttorque)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "mass": 0,
  • "inertia": null,
  • "earthshineIrradiance": 0,
  • "albedo": 1,
  • "dragTorque": [
    ],
  • "gravityGradientTorque": [
    ]
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Bus Regulator

Create Bus Regulator

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
inputType
required
any (Input Type)
Enum: "EPS_ROOT_NODE" "BUS_REGULATOR"

The input source to the regulator. If BUS_REGULATOR, inRegulator must be defined.

voltage
required
number (Output Voltage [V])
maxOutputPower
required
number (Max Output Power [W]) >= 0
efficiency
required
number (Efficiency) [ 0 .. 1 ]
inRegulator
string (ID of Associated BusRegulator Block)

Relationship to zero or one BusRegulator blocks. Reverse key: BusRegulator.outRegulators. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

topology
required
string (ID of Associated Topology Block)

Relationship to a Topology block. Reverse key: Topology.busRegulators. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "inputType": "EPS_ROOT_NODE",
  • "voltage": 0,
  • "maxOutputPower": 0,
  • "efficiency": 1,
  • "inRegulator": "string",
  • "topology": "string"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Bus Regulator

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Bus Regulator

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
inputType
required
any (Input Type)
Enum: "EPS_ROOT_NODE" "BUS_REGULATOR"

The input source to the regulator. If BUS_REGULATOR, inRegulator must be defined.

voltage
required
number (Output Voltage [V])
maxOutputPower
required
number (Max Output Power [W]) >= 0
efficiency
required
number (Efficiency) [ 0 .. 1 ]
inRegulator
string (ID of Associated BusRegulator Block)

Relationship to zero or one BusRegulator blocks. Reverse key: BusRegulator.outRegulators. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "inputType": "EPS_ROOT_NODE",
  • "voltage": 0,
  • "maxOutputPower": 0,
  • "efficiency": 1,
  • "inRegulator": "string"
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Attitude Determination Algorithm

Create Triad Algorithm

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
rate
required
number (Update Rate [Hz])
algorithmType
required
string (Algorithmtype)
Value: "ATTITUDE_DETERMINATION"
algorithmSubtype
required
any (AttDetTypes)
Enum: "TRIAD" "MEKF" "AVERAGING"

An enumeration.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "rate": 0,
  • "algorithmType": "ATTITUDE_DETERMINATION",
  • "algorithmSubtype": "TRIAD"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Triad Algorithm

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Triad Algorithm

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
rate
required
number (Update Rate [Hz])
algorithmType
required
string (Algorithmtype)
Value: "ATTITUDE_DETERMINATION"
algorithmSubtype
required
any (AttDetTypes)
Enum: "TRIAD" "MEKF" "AVERAGING"

An enumeration.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "rate": 0,
  • "algorithmType": "ATTITUDE_DETERMINATION",
  • "algorithmSubtype": "TRIAD"
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Create Averaging Algorithm

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
rate
required
number (Update Rate [Hz])
algorithmType
required
string (Algorithmtype)
Value: "ATTITUDE_DETERMINATION"
algorithmSubtype
required
string (Algorithmsubtype)
Value: "AVERAGING"
opticalAttitudeSensors
Array of any (IDs of Associated OpticalAttitudeSensor Blocks)
Default: []

Relationship to one or more OpticalAttitudeSensor blocks. On delete: SET_NONE (remove ID of referenced block from this relationship field).

angularVelocitySensors
Array of any (IDs of Associated AngularVelocitySensor Blocks)
Default: []

Relationship to one or more AngularVelocitySensor blocks. On delete: SET_NONE (remove ID of referenced block from this relationship field).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "rate": 0,
  • "algorithmType": "ATTITUDE_DETERMINATION",
  • "algorithmSubtype": "AVERAGING",
  • "opticalAttitudeSensors": [ ],
  • "angularVelocitySensors": [ ]
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Averaging Algorithm

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Averaging Algorithm

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
rate
required
number (Update Rate [Hz])
algorithmType
required
string (Algorithmtype)
Value: "ATTITUDE_DETERMINATION"
algorithmSubtype
required
string (Algorithmsubtype)
Value: "AVERAGING"
opticalAttitudeSensors
Array of any (IDs of Associated OpticalAttitudeSensor Blocks)
Default: []

Relationship to one or more OpticalAttitudeSensor blocks. On delete: SET_NONE (remove ID of referenced block from this relationship field).

angularVelocitySensors
Array of any (IDs of Associated AngularVelocitySensor Blocks)
Default: []

Relationship to one or more AngularVelocitySensor blocks. On delete: SET_NONE (remove ID of referenced block from this relationship field).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "rate": 0,
  • "algorithmType": "ATTITUDE_DETERMINATION",
  • "algorithmSubtype": "AVERAGING",
  • "opticalAttitudeSensors": [ ],
  • "angularVelocitySensors": [ ]
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Create MEKF Algorithm

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
rate
required
number (Update Rate [Hz])
algorithmType
required
string (Algorithmtype)
Value: "ATTITUDE_DETERMINATION"
algorithmSubtype
required
string (Algorithmsubtype)
Value: "MEKF"
covariance
any (Covariance)
opticalAttitudeSensors
Array of any (IDs of Associated OpticalAttitudeSensor Blocks)
Default: []

Relationship to one or more OpticalAttitudeSensor blocks. On delete: SET_NONE (remove ID of referenced block from this relationship field).

angularVelocitySensors
Array of any (IDs of Associated AngularVelocitySensor Blocks)
Default: []

Relationship to one or more AngularVelocitySensor blocks. On delete: SET_NONE (remove ID of referenced block from this relationship field).

satellite
string (ID of Associated Satellite Block)

Relationship to zero or one Satellite blocks. Reverse key: Satellite.algorithms. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "rate": 0,
  • "algorithmType": "ATTITUDE_DETERMINATION",
  • "algorithmSubtype": "MEKF",
  • "covariance": null,
  • "opticalAttitudeSensors": [ ],
  • "angularVelocitySensors": [ ],
  • "satellite": "string"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete MEKF Algorithm

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update MEKF Algorithm

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
rate
required
number (Update Rate [Hz])
algorithmType
required
string (Algorithmtype)
Value: "ATTITUDE_DETERMINATION"
algorithmSubtype
required
string (Algorithmsubtype)
Value: "MEKF"
covariance
any (Covariance)
opticalAttitudeSensors
Array of any (IDs of Associated OpticalAttitudeSensor Blocks)
Default: []

Relationship to one or more OpticalAttitudeSensor blocks. On delete: SET_NONE (remove ID of referenced block from this relationship field).

angularVelocitySensors
Array of any (IDs of Associated AngularVelocitySensor Blocks)
Default: []

Relationship to one or more AngularVelocitySensor blocks. On delete: SET_NONE (remove ID of referenced block from this relationship field).

satellite
string (ID of Associated Satellite Block)

Relationship to zero or one Satellite blocks. Reverse key: Satellite.algorithms. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "rate": 0,
  • "algorithmType": "ATTITUDE_DETERMINATION",
  • "algorithmSubtype": "MEKF",
  • "covariance": null,
  • "opticalAttitudeSensors": [ ],
  • "angularVelocitySensors": [ ],
  • "satellite": "string"
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Load

Create Constant Load

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
epsOutputType
required
any (Power Supply Bus)
Enum: "CORE_OUTPUT" "BUS_REGULATOR"

CORE_OUTPUT if connected to the regulated/unregulated Power Processor bus. BUS_REGULATOR if connected to a constant voltage BusRegulator output.

busRegulator
string (ID of Associated BusRegulator Block)

Relationship to zero or one BusRegulator blocks. Reverse key: BusRegulator.loads. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

topology
string (ID of Associated Topology Block)

Relationship to zero or one Topology blocks. Reverse key: Topology.loads. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

loadState
required
string (ID of Associated LoadState Block)

Relationship to a LoadState block. Reverse key: LoadState.loads. On delete: CASCADE (delete this block when referenced block is deleted).

loadDefType
required
any (Load Definition Type)
Enum: "CONSTANT_POWER" "CONSTANT_RESISTANCE"

An enumeration.

required
ConstantPower (object) or ConstantResistance (object) (Load Definition Parameters)
dutyCyclePeriod
number (Duty Cycle Period [min]) > 0
dutyCyclePercentage
number (Duty Cycle Percentage) [ 0 .. 1 ]

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "epsOutputType": "CORE_OUTPUT",
  • "busRegulator": "string",
  • "topology": "string",
  • "loadState": "string",
  • "loadDefType": "CONSTANT_POWER",
  • "loadDefParams": {
    },
  • "dutyCyclePeriod": 0,
  • "dutyCyclePercentage": 1
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Constant Load

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Constant Load

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
epsOutputType
required
any (Power Supply Bus)
Enum: "CORE_OUTPUT" "BUS_REGULATOR"

CORE_OUTPUT if connected to the regulated/unregulated Power Processor bus. BUS_REGULATOR if connected to a constant voltage BusRegulator output.

busRegulator
string (ID of Associated BusRegulator Block)

Relationship to zero or one BusRegulator blocks. Reverse key: BusRegulator.loads. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

topology
string (ID of Associated Topology Block)

Relationship to zero or one Topology blocks. Reverse key: Topology.loads. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

loadDefType
required
any (Load Definition Type)
Enum: "CONSTANT_POWER" "CONSTANT_RESISTANCE"

An enumeration.

required
ConstantPower (object) or ConstantResistance (object) (Load Definition Parameters)
dutyCyclePeriod
number (Duty Cycle Period [min]) > 0
dutyCyclePercentage
number (Duty Cycle Percentage) [ 0 .. 1 ]

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "epsOutputType": "CORE_OUTPUT",
  • "busRegulator": "string",
  • "topology": "string",
  • "loadDefType": "CONSTANT_POWER",
  • "loadDefParams": {
    },
  • "dutyCyclePeriod": 0,
  • "dutyCyclePercentage": 1
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Create Actuator Load

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
epsOutputType
required
any (Power Supply Bus)
Enum: "CORE_OUTPUT" "BUS_REGULATOR"

CORE_OUTPUT if connected to the regulated/unregulated Power Processor bus. BUS_REGULATOR if connected to a constant voltage BusRegulator output.

busRegulator
string (ID of Associated BusRegulator Block)

Relationship to zero or one BusRegulator blocks. Reverse key: BusRegulator.loads. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

topology
string (ID of Associated Topology Block)

Relationship to zero or one Topology blocks. Reverse key: Topology.loads. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

loadState
required
string (ID of Associated LoadState Block)

Relationship to a LoadState block. Reverse key: LoadState.loads. On delete: CASCADE (delete this block when referenced block is deleted).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "epsOutputType": "CORE_OUTPUT",
  • "busRegulator": "string",
  • "topology": "string",
  • "loadState": "string"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Actuator Load

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Actuator Load

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
epsOutputType
required
any (Power Supply Bus)
Enum: "CORE_OUTPUT" "BUS_REGULATOR"

CORE_OUTPUT if connected to the regulated/unregulated Power Processor bus. BUS_REGULATOR if connected to a constant voltage BusRegulator output.

busRegulator
string (ID of Associated BusRegulator Block)

Relationship to zero or one BusRegulator blocks. Reverse key: BusRegulator.loads. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

topology
string (ID of Associated Topology Block)

Relationship to zero or one Topology blocks. Reverse key: Topology.loads. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "epsOutputType": "CORE_OUTPUT",
  • "busRegulator": "string",
  • "topology": "string"
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Create Temperature Controller Load

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
epsOutputType
required
any (Power Supply Bus)
Enum: "CORE_OUTPUT" "BUS_REGULATOR"

CORE_OUTPUT if connected to the regulated/unregulated Power Processor bus. BUS_REGULATOR if connected to a constant voltage BusRegulator output.

busRegulator
string (ID of Associated BusRegulator Block)

Relationship to zero or one BusRegulator blocks. Reverse key: BusRegulator.loads. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

topology
string (ID of Associated Topology Block)

Relationship to zero or one Topology blocks. Reverse key: Topology.loads. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

loadState
required
string (ID of Associated LoadState Block)

Relationship to a LoadState block. Reverse key: LoadState.loads. On delete: CASCADE (delete this block when referenced block is deleted).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "epsOutputType": "CORE_OUTPUT",
  • "busRegulator": "string",
  • "topology": "string",
  • "loadState": "string"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Temperature Controller Load

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Temperature Controller Load

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
epsOutputType
required
any (Power Supply Bus)
Enum: "CORE_OUTPUT" "BUS_REGULATOR"

CORE_OUTPUT if connected to the regulated/unregulated Power Processor bus. BUS_REGULATOR if connected to a constant voltage BusRegulator output.

busRegulator
string (ID of Associated BusRegulator Block)

Relationship to zero or one BusRegulator blocks. Reverse key: BusRegulator.loads. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

topology
string (ID of Associated Topology Block)

Relationship to zero or one Topology blocks. Reverse key: Topology.loads. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "epsOutputType": "CORE_OUTPUT",
  • "busRegulator": "string",
  • "topology": "string"
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Condition

Create Condition

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
relationship
required
any (Relationship)
Enum: "GREATER" "LESS" "GREATER_EQUAL" "LESS_EQUAL" "EQUAL" "NOT_EQUAL"

An enumeration.

paramACategory
required
any (Parameter A Category)
Enum: "SATELLITE" "TARGET" "TARGET_GROUP" "TIME"

An enumeration.

paramBCategory
required
any (Parameter B Category)
Enum: "SATELLITE" "TARGET" "SCALAR"

An enumeration.

paramA
required
any (Parameter A Selection)
Enum: "SHADOW" "BETA" "MEAN_ANOM" "TRUE_ANOM" "LAT" "LON" "ALT" "LO_SIGHT" "RANGE" "SOLAR_AZ" "SOLAR_EL" "SAT_AZ" "SAT_EL" "LOCAL_SIDEREAL_TIME" ""

An enumeration.

paramB
any (Parameter B Selection)
Default: ""
Enum: "SHADOW" "BETA" "MEAN_ANOM" "TRUE_ANOM" "LAT" "LON" "ALT" "LO_SIGHT" "RANGE" "SOLAR_AZ" "SOLAR_EL" "SAT_AZ" "SAT_EL" "LOCAL_SIDEREAL_TIME" ""

An enumeration.

scalar
number (Scalar Value)

Set if paramBCategory == SCALAR.

targetA
string (ID of Associated Target Block)

Relationship to zero or one Target blocks. Reverse key: Target.conditions_A. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

targetB
string (ID of Associated Target Block)

Relationship to zero or one Target blocks. Reverse key: Target.conditions_B. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

targetGroupA
string (ID of Associated TargetGroup Block)

Relationship to zero or one TargetGroup blocks. Reverse key: TargetGroup.groupConditions_A. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

conOps
required
string (ID of Associated ConOps Block)

Relationship to a ConOps block. Reverse key: ConOps.conditions. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "relationship": "GREATER",
  • "paramACategory": "SATELLITE",
  • "paramBCategory": "SATELLITE",
  • "paramA": "SHADOW",
  • "paramB": "",
  • "scalar": 0,
  • "targetA": "string",
  • "targetB": "string",
  • "targetGroupA": "string",
  • "conOps": "string"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Condition

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Condition

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
relationship
required
any (Relationship)
Enum: "GREATER" "LESS" "GREATER_EQUAL" "LESS_EQUAL" "EQUAL" "NOT_EQUAL"

An enumeration.

paramACategory
required
any (Parameter A Category)
Enum: "SATELLITE" "TARGET" "TARGET_GROUP" "TIME"

An enumeration.

paramBCategory
required
any (Parameter B Category)
Enum: "SATELLITE" "TARGET" "SCALAR"

An enumeration.

paramA
required
any (Parameter A Selection)
Enum: "SHADOW" "BETA" "MEAN_ANOM" "TRUE_ANOM" "LAT" "LON" "ALT" "LO_SIGHT" "RANGE" "SOLAR_AZ" "SOLAR_EL" "SAT_AZ" "SAT_EL" "LOCAL_SIDEREAL_TIME" ""

An enumeration.

paramB
any (Parameter B Selection)
Default: ""
Enum: "SHADOW" "BETA" "MEAN_ANOM" "TRUE_ANOM" "LAT" "LON" "ALT" "LO_SIGHT" "RANGE" "SOLAR_AZ" "SOLAR_EL" "SAT_AZ" "SAT_EL" "LOCAL_SIDEREAL_TIME" ""

An enumeration.

scalar
number (Scalar Value)

Set if paramBCategory == SCALAR.

targetA
string (ID of Associated Target Block)

Relationship to zero or one Target blocks. Reverse key: Target.conditions_A. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

targetB
string (ID of Associated Target Block)

Relationship to zero or one Target blocks. Reverse key: Target.conditions_B. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

targetGroupA
string (ID of Associated TargetGroup Block)

Relationship to zero or one TargetGroup blocks. Reverse key: TargetGroup.groupConditions_A. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "relationship": "GREATER",
  • "paramACategory": "SATELLITE",
  • "paramBCategory": "SATELLITE",
  • "paramA": "SHADOW",
  • "paramB": "",
  • "scalar": 0,
  • "targetA": "string",
  • "targetB": "string",
  • "targetGroupA": "string"
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Solar Array

Create Solar Array

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
topology
required
string (ID of Associated Topology Block)

Relationship to a Topology block. Reverse key: Topology.solarArrays. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "topology": "string"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Solar Array

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Solar Array

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
panels
Array of any (IDs of Associated SolarPanel Blocks)
Default: []

Relationship to one or more SolarPanel blocks. Reverse key: SolarPanel.array. On delete: RESTRICT (prevent all referenced blocks from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "panels": [ ]
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Target

Create Space Target

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
conOps
required
string (ID of Associated ConOps Block)

Relationship to a ConOps block. Reverse key: ConOps.targets. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

targetType
string (Targettype)
Default: "SPACE_TARGET"
Value: "SPACE_TARGET"

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "conOps": "string",
  • "targetType": "SPACE_TARGET"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Space Target

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Space Target

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
targetType
string (Targettype)
Default: "SPACE_TARGET"
Value: "SPACE_TARGET"

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "targetType": "SPACE_TARGET"
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Create Celestial Target

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
targetType
string (Targettype)
Default: "CELESTIAL_TARGET"
Value: "CELESTIAL_TARGET"
polynomialEphemerisBody
required
any (Polynomial Ephemeris Body)
Enum: "SUN" "MOON"

The celestial body to target.

conOps
required
string (ID of Associated ConOps Block)

Relationship to a ConOps block. Reverse key: ConOps.targets. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "targetType": "CELESTIAL_TARGET",
  • "polynomialEphemerisBody": "SUN",
  • "conOps": "string"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Celestial Target

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Celestial Target

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
targetType
string (Targettype)
Default: "CELESTIAL_TARGET"
Value: "CELESTIAL_TARGET"
polynomialEphemerisBody
required
any (Polynomial Ephemeris Body)
Enum: "SUN" "MOON"

The celestial body to target.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "targetType": "CELESTIAL_TARGET",
  • "polynomialEphemerisBody": "SUN"
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Create Ground Target

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
conOps
required
string (ID of Associated ConOps Block)

Relationship to a ConOps block. Reverse key: ConOps.targets. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

targetType
string (Targettype)
Default: "GROUND_TARGET"
Value: "GROUND_TARGET"

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "conOps": "string",
  • "targetType": "GROUND_TARGET"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Ground Target

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Ground Target

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
targetType
string (Targettype)
Default: "GROUND_TARGET"
Value: "GROUND_TARGET"

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "targetType": "GROUND_TARGET"
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Thermal Interface

Create Thermal Interface

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
name
required
string (Name) <= 32 characters
area
required
number (Area) > 0
sideA
required
any (SideCategories)
Enum: "COMPONENT" "SURFACE" "COOLER"

An enumeration.

sideB
required
any (SideCategories)
Enum: "COMPONENT" "SURFACE" "COOLER"

An enumeration.

material
required
string (ID of Associated ThermalInterfaceMaterial Block)

Relationship to a ThermalInterfaceMaterial block. Reverse key: ThermalInterfaceMaterial.thermalInterface. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

componentA
string (ID of Associated Component Block)

Relationship to zero or one Component blocks. Reverse key: Component.thermal_interface_A. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

componentB
string (ID of Associated Component Block)

Relationship to zero or one Component blocks. Reverse key: Component.thermal_interface_B. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

surfaceA
string (ID of Associated Surface Block)

Relationship to zero or one Surface blocks. Reverse key: Surface.thermal_interface_A. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

surfaceB
string (ID of Associated Surface Block)

Relationship to zero or one Surface blocks. Reverse key: Surface.thermal_interface_B. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

coolerA
string (ID of Associated Cooler Block)

Relationship to zero or one Cooler blocks. Reverse key: Cooler.thermal_interface_A. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

coolerB
string (ID of Associated Cooler Block)

Relationship to zero or one Cooler blocks. Reverse key: Cooler.thermal_interface_B. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "area": 0,
  • "sideA": "COMPONENT",
  • "sideB": "COMPONENT",
  • "material": "string",
  • "componentA": "string",
  • "componentB": "string",
  • "surfaceA": "string",
  • "surfaceB": "string",
  • "coolerA": "string",
  • "coolerB": "string"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Thermal Interface

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Thermal Interface

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
name
required
string (Name) <= 32 characters
area
required
number (Area) > 0
sideA
required
any (SideCategories)
Enum: "COMPONENT" "SURFACE" "COOLER"

An enumeration.

sideB
required
any (SideCategories)
Enum: "COMPONENT" "SURFACE" "COOLER"

An enumeration.

material
required
string (ID of Associated ThermalInterfaceMaterial Block)

Relationship to a ThermalInterfaceMaterial block. Reverse key: ThermalInterfaceMaterial.thermalInterface. On delete: RESTRICT (prevent referenced block from being deleted while relationship to this one exists).

componentA
string (ID of Associated Component Block)

Relationship to zero or one Component blocks. Reverse key: Component.thermal_interface_A. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

componentB
string (ID of Associated Component Block)

Relationship to zero or one Component blocks. Reverse key: Component.thermal_interface_B. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

surfaceA
string (ID of Associated Surface Block)

Relationship to zero or one Surface blocks. Reverse key: Surface.thermal_interface_A. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

surfaceB
string (ID of Associated Surface Block)

Relationship to zero or one Surface blocks. Reverse key: Surface.thermal_interface_B. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

coolerA
string (ID of Associated Cooler Block)

Relationship to zero or one Cooler blocks. Reverse key: Cooler.thermal_interface_A. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

coolerB
string (ID of Associated Cooler Block)

Relationship to zero or one Cooler blocks. Reverse key: Cooler.thermal_interface_B. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "area": 0,
  • "sideA": "COMPONENT",
  • "sideB": "COMPONENT",
  • "material": "string",
  • "componentA": "string",
  • "componentB": "string",
  • "surfaceA": "string",
  • "surfaceB": "string",
  • "coolerA": "string",
  • "coolerB": "string"
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Orbit Determination Algorithm

Create EKF Algorithm

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
rate
required
number (Update Rate [Hz])
algorithmType
required
string (Algorithmtype)
Value: "ORBIT_DETERMINATION"
algorithmSubtype
required
string (Algorithmsubtype)
Value: "EKF"
covariance
Array of numbers (Covariance) [ items = 6 items ]
positionSensors
Array of any (IDs of Associated PositionSensor Blocks)
Default: []

Relationship to one or more PositionSensor blocks. On delete: SET_NONE (remove ID of referenced block from this relationship field).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "rate": 0,
  • "algorithmType": "ORBIT_DETERMINATION",
  • "algorithmSubtype": "EKF",
  • "covariance": [
    ],
  • "positionSensors": [ ]
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete EKF Algorithm

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update EKF Algorithm

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
rate
required
number (Update Rate [Hz])
algorithmType
required
string (Algorithmtype)
Value: "ORBIT_DETERMINATION"
algorithmSubtype
required
string (Algorithmsubtype)
Value: "EKF"
covariance
Array of numbers (Covariance) [ items = 6 items ]
positionSensors
Array of any (IDs of Associated PositionSensor Blocks)
Default: []

Relationship to one or more PositionSensor blocks. On delete: SET_NONE (remove ID of referenced block from this relationship field).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "rate": 0,
  • "algorithmType": "ORBIT_DETERMINATION",
  • "algorithmSubtype": "EKF",
  • "covariance": [
    ],
  • "positionSensors": [ ]
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Create GPS Algorithm

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
rate
required
number (Update Rate [Hz])
algorithmType
required
string (Algorithmtype)
Value: "ORBIT_DETERMINATION"
algorithmSubtype
required
string (Algorithmsubtype)
Value: "GPS"
positionSensors
Array of any (IDs of Associated PositionSensor Blocks)
Default: []

Relationship to one or more PositionSensor blocks. On delete: SET_NONE (remove ID of referenced block from this relationship field).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "rate": 0,
  • "algorithmType": "ORBIT_DETERMINATION",
  • "algorithmSubtype": "GPS",
  • "positionSensors": [ ]
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete GPS Algorithm

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update GPS Algorithm

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Name) <= 32 characters
rate
required
number (Update Rate [Hz])
algorithmType
required
string (Algorithmtype)
Value: "ORBIT_DETERMINATION"
algorithmSubtype
required
string (Algorithmsubtype)
Value: "GPS"
positionSensors
Array of any (IDs of Associated PositionSensor Blocks)
Default: []

Relationship to one or more PositionSensor blocks. On delete: SET_NONE (remove ID of referenced block from this relationship field).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "rate": 0,
  • "algorithmType": "ORBIT_DETERMINATION",
  • "algorithmSubtype": "GPS",
  • "positionSensors": [ ]
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Simulation Clock Configuration

Create Simulation Clock Configuration

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
startTime
required
number (Start Time [MJD])

The time at which the simulation begins simulating from.

stopTime
required
number (Stop Time [MJD])

The time at which the simulation completes.

realTime
boolean (Real-Time Mode)
Default: false

If true, the simulation will run faster than real-time up to current wall time and then step in sync with wall time.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "startTime": 0,
  • "stopTime": 0,
  • "realTime": false
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Simulation Clock Configuration

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Simulation Clock Configuration

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
startTime
required
number (Start Time [MJD])

The time at which the simulation begins simulating from.

stopTime
required
number (Stop Time [MJD])

The time at which the simulation completes.

realTime
boolean (Real-Time Mode)
Default: false

If true, the simulation will run faster than real-time up to current wall time and then step in sync with wall time.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "startTime": 0,
  • "stopTime": 0,
  • "realTime": false
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Agent Template Reference

Create Agent Template Reference

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
ref
required
integer (Agent Template Ref)

The ID of the referenced Agent Template Branch.

agents
Array of any (IDs of Associated Agent Blocks)
Default: []

Relationship to one or more Agent blocks. Reverse key: Agent.templateRef. On delete: SET_NONE (remove ID of referenced block from this relationship field).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "ref": 0,
  • "agents": [ ]
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Agent Template Reference

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Agent Template Reference

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
ref
required
integer (Agent Template Ref)

The ID of the referenced Agent Template Branch.

agents
Array of any (IDs of Associated Agent Blocks)
Default: []

Relationship to one or more Agent blocks. Reverse key: Agent.templateRef. On delete: SET_NONE (remove ID of referenced block from this relationship field).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "ref": 0,
  • "agents": [ ]
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}

Simulated Agent

Create Simulated Agent

path Parameters
branchId
required
integer (Branchid)
Request Body schema: application/json
id
string (Id)
name
required
string (Agent Name) <= 32 characters

The unique name of this Agent.

peripheral
boolean (Peripheral Flag)
Default: false

If true, this Agent is considered a Peripheral Agent within the Scenario.

object (Target Agent Mapping)
Default: {}

A mapping from the Target Block IDs of this Agent to the IDs of other Agents in the Scenario.

differentiatingState
object (Differentiating State)
Default: {}

State used to differentiate this Agent from others instantiated from the same Agent Template. This object is merged with the Agent Template model before the simulation begins. State variable organization must be identical to the Agent Template model in order to successfully overwrite it.

templateRef
string (ID of Associated TemplateRef Block)

Relationship to zero or one TemplateRef blocks. Reverse key: TemplateRef.agents. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "peripheral": false,
  • "targetMapping": { },
  • "differentiatingState": { },
  • "templateRef": "string"
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "block": {
    },
  • "branch": {
    }
}

Delete Simulated Agent

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)

Responses

Response samples

Content type
application/json
{
  • "action": "DELETE",
  • "block": {
    },
  • "branch": {
    }
}

Update Simulated Agent

path Parameters
branchId
required
integer (Branchid)
blockId
required
integer (Blockid)
Request Body schema: application/json
id
string (Id)
name
required
string (Agent Name) <= 32 characters

The unique name of this Agent.

peripheral
boolean (Peripheral Flag)
Default: false

If true, this Agent is considered a Peripheral Agent within the Scenario.

object (Target Agent Mapping)
Default: {}

A mapping from the Target Block IDs of this Agent to the IDs of other Agents in the Scenario.

differentiatingState
object (Differentiating State)
Default: {}

State used to differentiate this Agent from others instantiated from the same Agent Template. This object is merged with the Agent Template model before the simulation begins. State variable organization must be identical to the Agent Template model in order to successfully overwrite it.

templateRef
string (ID of Associated TemplateRef Block)

Relationship to zero or one TemplateRef blocks. Reverse key: TemplateRef.agents. On delete: SET_NONE (set relationship field to None when referenced block is deleted).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "peripheral": false,
  • "targetMapping": { },
  • "differentiatingState": { },
  • "templateRef": "string"
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "block": {
    },
  • "branch": {
    }
}